# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys

sys.path.insert(0, os.path.abspath('../src'))
sys.path.append("..")
sys.setrecursionlimit(5000)
from doc.auto_document_models import write_models_to_md
from VeraGridEngine.__version__ import __VeraGridEngine_VERSION__

# -- Project information -----------------------------------------------------

project = 'VeraGrid'
copyright = '2025, Santiago Peñate Vera et. al.'
author = 'Santiago Peñate Vera et. al.'

# The full version, including alpha/beta/rc tags
release = __VeraGridEngine_VERSION__


def setup(app):
    app.add_css_file('style.css')


# -- General configuration ---------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
exclude_patterns = ['zzz']

numfig = True

extensions = list()
extensions.append('sphinx.ext.todo')
extensions.append('sphinx.ext.autodoc')
extensions.append('sphinx.ext.intersphinx')
extensions.append('sphinx.ext.imgmath')
extensions.append('sphinx.ext.mathjax')
extensions.append('sphinx.ext.viewcode')
extensions.append('sphinx.ext.graphviz')
extensions.append('sphinx_rtd_theme')
#extensions.append("sphinxawesome_theme")
# extensions.append('sphinx_build_compatibility.extension')
extensions.append('myst_parser')  # markdown

autosummary_generate = True
myst_dmath_allow_labels = True

# generate CGMES, PSSe and VeraGrid data models' rst files
write_models_to_md(os.path.join('md_source', 'data_models.md'))

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
source_suffix = ['.rst', '.md']

myst_enable_extensions = [
    "amsmath",
    "attrs_inline",
    "colon_fence",
    "deflist",
    "dollarmath",
    "fieldlist",
    "html_admonition",
    "html_image",
    "linkify",
    "replacements",
    "smartquotes",
    "strikethrough",
    "substitution",
    "tasklist",
]

# The master toctree document.
master_doc = 'index'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
# html_theme = 'nature'
html_theme = 'sphinx_rtd_theme'
# html_theme = 'sphinxawesome_theme'

html_theme_options = {
    "show_prev_next": False,
    "show_breadcrumbs": False,
    "breadcrumbs_separator": "·",
    "awesome_headerlinks": False,
    "show_scrolltop": True,
    "show_permalinks": False,
    "awesome_external_links": True,
    "main_nav_links": { "GitHub": "https://github.com/SanPen/VeraGrid"},
    "extra_header_link_icons": {
        "Discord": {"link": "https://discord.gg/xxx", "icon": "<svg>...</svg>"}
    },
    "logo_light": "img/VeraGrid3_icon.svg",
    "logo_dark": "img/VeraGrid3_icon.svg",
    "globaltoc_includehidden": False,
}

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'VeraGriddoc'

# -- Options for LaTeX output ------------------------------------------------

fh = open('latex_preamble.tex', 'r+')
PREAMBLE = fh.read()
fh.close()
latex_engine = 'xelatex'
latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    'papersize': 'a4paper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    'pointsize': '10pt',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',

    # Additional stuff for the LaTeX preamble.
    'preamble': PREAMBLE,
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'VeraGrid.tex', 'VeraGrid Documentation', 'Santiago Peñate Vera', 'manual'),
]

# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'veragrid', 'VeraGrid Documentation',
     [author], 1)
]

# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'VeraGrid', 'VeraGrid Documentation',
     author, 'VeraGrid', 'One line description of project.',
     'Miscellaneous'),
]

# -- Options for Epub output -------------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

# -- Extension configuration -------------------------------------------------
